Move docs to the repo root - #132
Merged
Merged
Conversation
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
Greptile SummaryThe PR relocates the MkDocs source directory from
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| mkdocs.yml | Moves docs_dir and edit links to repository-root documentation and configures Mermaid fences. |
| .github/workflows/docs.yml | Updates documentation workflow path filters so changes under docs/ trigger strict builds and deployment. |
| sdk/scripts/check_doc_drift.py | Retargets API-reference scanning from sdk/docs/*.md to the equivalent root-level documentation glob. |
| sdk/tests/integration/test_deployment_modes.py | Adjusts repository-root traversal so the deployment-document assertion resolves the relocated file. |
| sdk/README.md | Rewrites documentation links relative to the SDK subdirectory for the new root-level location. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart LR
Source["Repository-root docs/"] --> MkDocs["MkDocs strict build"]
Config["mkdocs.yml"] --> MkDocs
Workflow["Documentation workflow"] --> MkDocs
MkDocs --> Artifact["GitHub Pages artifact"]
Artifact --> Site["Published documentation"]
Reviews (3): Last reviewed commit: "merge dev into docs move" | Re-trigger Greptile
SDK Coverage •
|
chiruu12
marked this pull request as draft
August 17, 2026 12:12
Collaborator
Author
# Conflicts: # README.md
chiruu12
marked this pull request as ready for review
August 24, 2026 12:59
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
sdk/docs/ becomes docs/, the layout every comparable repo uses and
the first place a contributor looks.
Site URLs are unchanged since mkdocs derives them from filenames
inside docs_dir. Updated docs_dir, edit_uri, the labeler globs, the
docs workflow path filters, the drift checker globs, the issue and
PR templates, and pyproject's Documentation URL.
Grepping for "sdk/docs" only found 21 of the references. sdk/README.md
and the integration READMEs linked relatively as docs/X.md and
../docs/X.md, twelve files with no "sdk" in the path. A link check
over all tracked markdown found those, and now reports 0 broken links
repo-wide.
test_deployment_doc_exists resolved the doc through
manifest_path().parents[1], which was sdk/. Now parents[2].
Two things not caused by the move, taken while in here: the README
had four em dashes, now commas and full stops; and
.github/actions/unplug-scan/README.md linked to ../workflows/
instead of ../../workflows/.
The nine files GitHub reads by convention stay at root: README,
LICENSE, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, SUPPORT, plus
Makefile, .gitignore and .pre-commit-config.yaml.